home *** CD-ROM | disk | FTP | other *** search
/ Acorn RISC PD-CD 1 / Acorn RISC PD-CD 1.iso / languages / dde / _pc / h / baricon < prev    next >
Text File  |  1992-02-09  |  5KB  |  118 lines
  1. (*
  2.  * Title: baricon.h
  3.  * Purpose: Support placing of an icon on the icon bar.
  4.  *
  5.  *)
  6.  
  7. #ifndef __baricon_h
  8. #define __baricon_h
  9.  
  10. # ifndef __wimp_h
  11. # include "wimp.h"
  12. # endif
  13.  
  14. (* -------------------------baricon_clickproc---------------------- *)
  15.  
  16. (* baricon_clickproc is the type of a function to be called when Select 
  17.  * is clicked.
  18.  *)
  19. type baricon_clickproc = ^procedure clickproc(i : wimp_i);
  20.  
  21. (* ----------------------------- baricon -----------------------------------
  22.  * Description:   Installs the named sprite as an icon on the right of the 
  23.  *                icon bar and registers a function to be called when Select 
  24.  *                is clicked.
  25.  *
  26.  * Parameters:    char *spritename     -- name of sprite to be used
  27.  *                int spritearea       -- area in which sprite is held
  28.  *                baricon_clickproc p  -- pointer to function to be
  29.  *                                        called on left mouse click
  30.  * Returns:       the icon number of the installed icon (of type wimp_i).
  31.  *                This will be passed to function "p" on left mouse click.
  32.  * Other info:    For details of installing a menu handler for this icon
  33.  *                see event_attachmenu().
  34.  *) 
  35. procedure baricon(spritename : string;
  36.                  spritearea : integer;
  37.                  p : baricon_clickproc) : wimp_i; extern;
  38.  
  39. (* -------------------------------- baricon_left --------------------------
  40.  * Description:   Installs the named sprite as an icon on the left of the
  41.  *                icon bar and regsiters a function to be called when Select
  42.  *                is clicked.
  43.  *
  44.  * Parameters:    As for baricon, above.
  45.  * Returns:       As for baricon, above.
  46.  * Other info:    As for baricon, above.
  47.  *)
  48. procedure baricon_left(spritename : string;
  49.                  spriteare : integer;
  50.                  p : baricon_clickproc) : wimp_i; extern;
  51.  
  52. (* ----------------------------- baricon_textandsprite --------------------
  53.  * Description:   Installs the named sprite as an icon on the right of the 
  54.  *                icon bar with some given text below it, and registers a 
  55.  *                function to be called when Select is clicked.  
  56.  *
  57.  * Parameters:    char *spritename     -- name of sprite to be used
  58.  *                char *text           -- text to appear under sprite
  59.  *                int bufflen          -- length of text buffer
  60.  *                int spritearea       -- area in which sprite is held
  61.  *                baricon_clickproc p  -- pointer to function to be
  62.  *                                        called on left mouse click
  63.  * Returns:       the icon number of the installed icon (of type wimp_i).
  64.  *                This will be passed to function "p" on left mouse click.
  65.  * Other info:    For details of installing a menu handler for this icon
  66.  *                see event_attachmenu().
  67.  *                The width of the icon is taken as the greater of bufflen
  68.  *                system font characters and the width of the sprite used.
  69.  *
  70.  *) 
  71. procedure baricon_textandsprite(spritename : string;
  72.                 text : string;
  73.                 bufflen : integer;
  74.                 spritearea : integer;
  75.                 p : baricon_clickproc) : wimp_i; extern;
  76.  
  77. (* -------------------------- baricon_textandsprite_left ------------------
  78.  * Description:   Installs the named sprite as an icon on the right of the 
  79.  *                icon bar with some given text below it, and registers a 
  80.  *                function to be called when Select is clicked.  
  81.  *
  82.  * Parameters:    char *spritename     -- name of sprite to be used
  83.  *                char *text           -- text to appear under sprite
  84.  *                int bufflen          -- length of text buffer
  85.  *                int spritearea       -- area in which sprite is held
  86.  *                baricon_clickproc p  -- pointer to function to be
  87.  *                                        called on left mouse click
  88.  * Returns:       the icon number of the installed icon (of type wimp_i).
  89.  *                This will be passed to function "p" on left mouse click.
  90.  * Other info:    For details of installing a menu handler for this icon
  91.  *                see event_attachmenu().
  92.  *                The width of the icon is taken as the greater of bufflen
  93.  *                system font characters and the width of the sprite used.
  94.  *
  95.  *) 
  96. procedure baricon_textandsprite_left(spritename : string;
  97.                 text : string;
  98.                 bufflen : integer;
  99.                 spritearea : integer;
  100.                 p : baricon_clickproc) : wimp_i; extern;
  101.  
  102.  
  103. (* ----------------------------- baricon_newsprite -------------------------
  104.  * Description:   Changes the sprite used on the icon bar
  105.  *
  106.  * Parameters:    char *newsprite  -- name of new sprite to be used
  107.  *
  108.  * Returns:       the icon number of the installed icon sprite
  109.  * Other Info:    Newsprite must be held in the same sprite area as
  110.  *                the sprite used in baricon()
  111.  *
  112.  *)
  113. procedure baricon_newsprite(newsprite : string) : wimp_i; extern;
  114.  
  115. #endif
  116.  
  117. (* end baricon.h *)
  118.